home *** CD-ROM | disk | FTP | other *** search
/ Collection of Internet / Collection of Internet.iso / winprogs / squiggle / squiggle.doc < prev    next >
Encoding:
Text File  |  1994-10-25  |  8.3 KB  |  227 lines

  1.      Documentation for Mr SQUIGGLE -  Winsock point-to-point blackboard 
  2.  
  3. Last changed 11 Jun 94   
  4.  
  5. Introduction
  6. ------------
  7.  
  8. Mr Squiggle is a Windows 3.1/WINSOCK based point-to-point electronic
  9. blackboard.  It allows 2 people connected via the Internet to share a
  10. common drawing surface, a bit like Microsoft's Paintbrush (probably
  11. Registered Names and/or Trademarks of Microsoft Corp).
  12.  
  13. The name "Mr Squiggle" (probably a Registered Name or Trademark of the
  14. Australian Broadcasting Corporation (ABC)) comes from a very popular
  15. children's program shown in Australia since the 1960's.  It's star is a
  16. floppy sort of puppet with a very long pencil for a nose.  At the start
  17. of each program, he flies down from the moon in his faithful rocket, and
  18. is met by his human assistant ("Miss Pat", "Miss Jane", ...) and his earth
  19. based, personality-filled "Blackboard".  Children mail in bits of paper
  20. with random sorts of "squiggles", and Mr Squiggle, with a few deft strokes 
  21. from his nose/pencil, miraculously creates funny drawings, such as an 
  22. elephant making a peanut-butter sandwich, or a butterfly knitting a
  23. scarf.  More often than not, the squiggle must be rotated before the
  24. picture becomes recognizable.
  25.  
  26. If you are one of the small group of people who can draw better than they
  27. can talk, and who likes using a mouse to draw, then you might like
  28. Mr Squiggle.
  29.  
  30. This Mr Squiggle is a program written entirely in Microsoft's Visual Basic 3,
  31. Professional Edition.  
  32.                
  33.  
  34. Installation and Use
  35. --------------------
  36.  
  37. The release directory contains:
  38.  
  39.     - squiggle.doc    - this documentation
  40.     - squiggle.zip    - Windows 3.1 files in pkzip format
  41.  
  42.  
  43. You must have successfully installed a "winsock" TCP/IP stack before 
  44. Mr Squiggle can be run.
  45.  
  46.   1     Copy squiggle.zip to your PC and unzip it into an arbitrary
  47.     directory.
  48.  
  49.   2     Some Visual Basic V3 executables/libraries must be copied to the
  50.     windows system directory:
  51.  
  52.         -  msgblast.vbx    (Ed Staffin's VB Windows Event hook)
  53.         -  threed.vbx
  54.         -  cmdialog.vbx
  55.         -  vbrun300.dll
  56.    
  57.    3    The squiggle.ini file should be copied to the windows directory. 
  58.  
  59.    4    The Mr Squiggle executable (squiggle.exe) should be 
  60.     defined to the program manager (no working directory
  61.     is required).
  62.  
  63.     On starting for the first time, define your local friendly name
  64.     using the Configure Menu and add a few definitions for other
  65.     users of Mr Squiggle which you can draw with.  
  66.     
  67.     A definition consists of:
  68.         
  69.         - a friendly name, which appears later in the open 
  70.           connection list box
  71.         - the machine name (as known to DNS or whatever else your
  72.           winsock program uses to resolve names)
  73.         - the Mr Squiggle TCP/IP port number which you will
  74.           attempt to connect to on the other machine (defaults
  75.           to "4253")
  76.  
  77.     Press "ADD" to add a new definition to the list of other host
  78.     definitions.
  79.  
  80.     If you want to change an existing definition, click it and then
  81.     click "MODIFY" (or double click the definition) - the definition
  82.     will be removed from the top list and be made available for 
  83.     editing - dont forget to press "ADD" to reinsert it in the list
  84.     of other host definitions.
  85.  
  86.     To make the changes permanent, you must press the big "OK"
  87.     button on the bottom of the configuration form.
  88.  
  89.  
  90.     When you start Mr Squiggle, you should probably put it into
  91.     "listening" mode, so that other users may contact you.  This is
  92.     done by choosing "Connection" and then "Wait for Connection".
  93.     (This should happen automatically - see the "autolisten" parameter
  94.     in the squiggle.ini file).
  95.  
  96.     The little status message should change to "listening", indicating
  97.     that you Winsock stack is now listening for a connection on your 
  98.     behalf.  The port that you listen on defaults to "4253", but this
  99.     can be changed by manually editing your windows directory
  100.     squiggle.ini file.
  101.  
  102.     If you want to initiate a connection with another listening Mr
  103.     Squiggle user, simple choose "Connection" and then "Call Another
  104.     Mr Squiggle".  If you were previously in a "listening" state,
  105.     you will first need to choose "Connection" and then "Disconnect"
  106.     to release the "listening" mode.
  107.  
  108.     Having chosen "Call Another Mr Squiggle", you will be presented 
  109.     with a list box containing the friendly names from the "Configure"
  110.     panel.  Simply click an entry, and then click "Connect".
  111.  
  112.     Mr Squiggle will then attempt to contact the previously configured
  113.     machine and port.  If it is successful, the little status message
  114.     will change to "Connected to <machine name>", and the Blackboard
  115.     form will be displayed!
  116.  
  117.     The Blackboard form is deliberately meant to look like the
  118.     Microsoft Paintbrush program, but it is not as fully featured.
  119.     Still, you can draw lines, boxes, circles, select colours and
  120.     fonts, and erase previous work.  The drawing area can be cleared
  121.     and a funny option ("Draw Options", "Overlay") toggles how shapes
  122.     appear on top of one another.
  123.  
  124.     When you are finished, click Exit on the Blackboard!
  125.  
  126.  
  127.  
  128. Availability
  129. -------------
  130.  
  131. Written by Kent Fitch, ITSB, CSIRO Australia  kent.fitch@its.csiro.au
  132. Copyright CSIRO 1994, all rights reserved (must not be stolen or resold).
  133. Executables and doco in the public domain, source code available for 
  134. a donation to CSIRO.  Use at your own risk.
  135.  
  136. CSIRO is the largest publicly funded scientific research organization in the
  137. world.  It operates a large variety of research programs at sites across 
  138. Australia.
  139.  
  140. The home ftp site for Mr Squiggle is commsun.its.csiro.au, in anon ftp 
  141. directory csiro/win3/squiggle
  142.  
  143.  
  144.  
  145. History
  146. -------
  147.  
  148. Versions:
  149.  
  150. 02Jan94 Beta 0.00       
  151. 14Feb94 Beta 0.10      convert to VBWSK.VBX, numerous bug fixes, robustness
  152.                improvements
  153. 06Mar94 Beta 0.22      change to half-duplex, token passing (see bug list)
  154.                new tools - outline (cut/copy/paste/delete)
  155.                  - rounded rect
  156.                  - paint roller
  157.                  - spray can
  158.                
  159.             file load/save bitmaps (but load can be slow!)
  160.  
  161. 07Mar94 Beta 0.23       tiny weeny bug fixed
  162. 12Mar94 Beta 0.24       "send beep" added
  163. 04Jun94 Beta 0.26       major rewrite:
  164.             - replaced vbwsk.vbx socket control with native
  165.               async calls to the Winsock.DLL.  I did this
  166.               because I suspected a problem in vbwsk.vbx
  167.               with events being lost when a modal window
  168.               was open, but this even happened with the direct
  169.               calls to WINSOCK.  Oh well, it was fun doing
  170.               all the async calls using msgblast.vbx...
  171.             - .bmp/.ico transfer speeded up and made more
  172.               device independent - previously we read the
  173.               colours "off the screen" - now we file transfer
  174.               the .bmp/.ico file to the session partner
  175. 11Jun94 Beta 0.28       fix problem with connect                         
  176.  
  177.  
  178. Acknowledgements
  179. ----------------
  180.  
  181. Mr Squiggle originally used my own VB-Winsock Interface code, but I decided 
  182. to check out Brian Syme's VBWSK.VBX, release 0.3, as it enabled me
  183. to remove a lot of VB code, which I thought might offset the disadvantage
  184. of not having the full flexibility of the WINSOCK interface and the source
  185. code for the WINSOCK interface code.  It works very well!  Thank you, Brian, 
  186. for putting this VBX in the public domain.  
  187.  
  188. Well, now I dont use it any more but still, thanks Brian.  Thanks to 
  189. Ed Staffin for msgblast.vbx (I think I use a by-now ancient version, 
  190. but it's fine)
  191.  
  192. Mark Eldridge, from CSIRO, for lots of good ideas & encouragement & testing. 
  193.  
  194. Microsoft VISUAL BASIC developers
  195.  
  196. WINSOCK specification designers 
  197.  
  198.  
  199. Bugs/Limitations
  200. ----------------
  201.  
  202. 1.  Not all the Paintbrush tools are implemented
  203.  
  204. 2.  No notification is received if a font is used which is not available on
  205.     the other machine.
  206.  
  207. 3.  Blackboard cant be resized.
  208.  
  209. 4.  Undo only remembers last drawing action, and only works on some 
  210.     drawing tools.
  211.  
  212. 5.  Character tool processing is very limited - no tab, backspace....
  213.  
  214. 6.  Only 50 other Mr Squiggle hosts can be configured.
  215.  
  216. 7.  Local friendly name is not transmitted to other host.
  217.  
  218. 8.  Cant have a 3-, 4- or more-way Mr Squiggle session.
  219.  
  220. 9.  Current version can not interoperate with versions below 0.26
  221.  
  222. 10.  Occassionaly, things go wrong - especially if user drags the
  223.     "transfer in progress box" during a big bitmap transfer.
  224.  
  225. 11.  .bmp/.ico become white squares in SVGA with > 256 colours, at least
  226.      with a Diamond Stealth 32 video card (?)
  227.